home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #14 / Monster Media No. 14 (April 1996) (Monster Media, Inc.).ISO / bbs_util / bbsedit1.zip / BBSEDIT.DOC < prev    next >
Text File  |  1996-02-26  |  12KB  |  246 lines
  1.                           BBSEdit v1.0
  2.                   Copyright 1996, Sergey Polak
  3.  
  4.  
  5.                            DISCLAIMER
  6.  
  7.      This program and other files associated with it are NOT
  8. guaranteed to be bug free or virus free.  I am not responsible for
  9. damages of any kind, including profit losses and data losses, that
  10. relate directly or indirectly to these programs and files.
  11.  
  12.                    DISTRIBUTION OF THE PROGRAM
  13.  
  14.      You are free to distribute the program as long as you include
  15. all the files in the archive in their original format.  You may NOT
  16. charge any fee for the distribution of the program, other than for
  17. the media on which you distribute it.
  18.  
  19.                           INSTALLATION
  20.  
  21.      BBSEdit will only work with Telegard BBS software v3.0 (or
  22. 2.99Gamma).  You must also have DOS v3.3 or above.  Installing
  23. BBSEdit is very easy.  All you have to do is put the two required
  24. files -- BBSEDIT.EXE and BBSEDIT.HLP -- in the directory or your
  25. choice.
  26.  
  27. NOTE:     If you're running in a multitasking environment, please
  28.           read the section entitled MULTITASKING CONSIDERATIONS!
  29.  
  30.                          RUNNING BBSEDIT
  31.  
  32.      BBSEdit can be executed in two modes:  interactive and event. 
  33. Interactive mode is the one you use to edit the BBS list.  In
  34. interactive mode you are presented with windows, pull-down menus
  35. and other similar devices.  Event mode is used to run BBSEdit in an
  36. event, such as nightly maintenance, to sort a BBS list and/or strip
  37. high ASCII characters.
  38.  
  39. To run BBSEdit in interactive mode execute it as follows:
  40.  
  41. BBSEDIT [/T:path] [/L:filename]
  42.  
  43. /T:path -      In order to run, BBSEdit requires access to your
  44.                CONFIG.TG.  Unless CONFIG.TG can be found in the
  45.                current directory, in your path or in the path
  46.                specified by the TELEGARD environment variable, you
  47.                have to put the PATH to CONFIG.TG on the command-
  48.                line with the /T: switch.  Do *NOT* include the
  49.                filename!
  50.  
  51. /L:filename -  When BBSEdit starts, it attempts to load the file
  52.                BBSLIST.BBS from your DATA directory.  If you would
  53.                like BBSEdit to load another BBS list, put the
  54.                filename on the command-line with the /L: switch. 
  55.                If the BBS list is in your DATA directory, you do
  56.                not need to include the path.  If the extension is
  57.                .BBS, you do not need to include the extension
  58.                either.
  59.  
  60. If you do not want to use the /T: parameter, you can create a
  61. configuration file for BBSEdit.  The file must be called
  62. BBSEDIT.CFG and it's first line must contain the PATH to your
  63. CONFIG.TG.  You can put anything else in the file after the first
  64. line, as BBSEdit does not read that far.
  65.  
  66. To run BBSEdit in event mode execute it as follows:
  67.  
  68. BBSEDIT [/L:filename] /S:by,order [/C] [/H]
  69.  
  70. /L:filename -  The name of the BBS list to process.  If you don't
  71.                include this parameter, BBSLIST.BBS is assumed. 
  72.                See the /L: switch above for more information.
  73.  
  74. /S:by,order -  This switch tells BBSEdit to sort the specified BBS
  75.                list and exit.  The /S: switch takes two
  76.                parameters, separated by a comma.  The first tells
  77.                BBSEdit what field to use as the sorting key.  It
  78.                must be one of the following characters:
  79.                     P - phone number
  80.                     N - BBS name
  81.                     S - Sysop
  82.                     D - Description
  83.                     E - Speed
  84.                     W - software
  85.                The second parameter tells BBSEdit what order to
  86.                sort the list in.  It must either be the letter A
  87.                for Ascending or the letter D for Descending.
  88.  
  89. /C -           This optional parameter tells BBSEdit that the sort
  90.                is to be case SENSITIVE.  By default the sort is
  91.                NOT case sensitive.  In a case sensitive sort
  92.                upper-case letters come before lower case ones! 
  93.                This parameter has no effect without the /S:
  94.                switch.
  95.  
  96. /H -           This parameter tells BBSEdit to remove all high
  97.                ASCII characters from the BBS list.  For the
  98.                purposes of BBSEdit, high ASCII characters are
  99.                characters whose codes are 0 to 31 and 127 to 255. 
  100.                These include non-printable control characters as
  101.                well as ASCII graphics and non-English letters. 
  102.                This switch CAN be used INDEPENDENTLY of the /S:
  103.                switch, or in conjunction with it.
  104.  
  105. When used in event mode, BBSEdit will not expect any input from the
  106. user whatsoever.  Error messages will be output to the screen.
  107.  
  108.                         USING THE PROGRAM
  109.  
  110.      When used in interactive mode, BBSEdit allows you to easily
  111. modify BBS lists in a friendly and powerful environment with a
  112. context-sensitive help system.  All options in BBSEdit are
  113. accessible via the mouse or the indicated hotkey.  The menu bar at
  114. the top of the screen can be accessed by pressing the F10 key.
  115.  
  116.      At the heart of BBSEdit lies the BBS List Window.  This window
  117. displays the open BBS list and allows you to modify it.  You can
  118. edit entries, add new ones at the end of the list, insert new
  119. entries anywhere in the list, delete entries, copy and cut them to
  120. the clipboard as well as paste them from clipboard.
  121.  
  122.      Because of the extensive context-sensitive help system, I am
  123. not going to explain the use of every single option in this
  124. document.  Most key combinations are self-explanatory.  DEL deletes
  125. entries, while INS inserts them.  To add an entry use Ctrl+A. 
  126. Pressing ENTER or double-clicking on an entry edits it.  Shift+DEL
  127. cuts an entry to the clipboard, while Ctrl+INS copies it. 
  128. Shift+INS pastes the entry at the current location (similar to
  129. inserting a new one) while Ctrl+V pastes it at the end of the BBS
  130. list.  The up/down arrow keys, PgUp and PgDown, Ctrl+PgUp and
  131. Ctrl+PgDown as well as Home and End keys let you scroll through the
  132. list vertically (Home and End go to the top and bottom visible
  133. entry, while Ctrl+PgUp and Ctrl+PgDown go to the top and bottom
  134. entry of the list).  The left/right arrow keys as well as Ctrl+Home
  135. and Ctrl+End let you scroll through the list horizontally.  And, of
  136. course, the most important key combination of them all:  Alt+X
  137. exits the program.
  138.  
  139.      If you need help at any time, press the F1 key.  The only time
  140. F1 will do nothing is when you're already in the help system. 
  141. Getting around the help system is relatively easy.  The arrow keys
  142. scroll the text up/down and left/right.  Text that appears in
  143. yellow is actually a link to another help topic.  The Tab and
  144. Shift+Tab keys cycle through all the links in the current topic. 
  145. To go to the selected topic, press the ENTER key.  You can
  146. backtrack through the topics with the Alt+F1 key combination.  To
  147. close the help window press the ESC key.
  148.  
  149.                       ON MULTIPLE BBS LISTS
  150.  
  151.      BBSEdit lets you take full advantage of using multiple BBS
  152. lists with Telegard by allowing you to have up to 9 BBS lists open
  153. at the same time.  On certain occasions, such as when you are
  154. running low on memory or under certain operating systems (such as
  155. Windows for Workgroups 3.11) you will only be able to have 6 BBS
  156. lists open.
  157.  
  158.      BBSEdit's cut-and-paste editing allows you to copy and move
  159. entries from one BBS list to another.  Unfortunately you have to do
  160. this one entry at a time at this point.  Hopefully you will be able
  161. to move multiple entries in future versions.
  162.  
  163.                    MULTITASKING CONSIDERATIONS
  164.  
  165.      When BBSEdit opens a BBS list, it locks the file against
  166. writes, so the contents does not change while you're editing it. 
  167. Unfortunately that causes Telegard to crash with a run-time error
  168. if a user tries to ADD to the BBS list or EDIT it while you're in
  169. BBSEdit editing it.  This does *NOT* happen if the user only looks
  170. at the BBS list.
  171.  
  172.      To help you avoid this problem, BBSEdit creates a semaphore
  173. file in the same directory as the open BBS list.  The file is named
  174. bbslist.USE, where bbslist is the name of BBS list.  If the BBS
  175. list's extension was .USE, then BBSEdit uses the .SEM extension. 
  176. Included in this archive is a sample script file that can help you
  177. avoid the run-time error.  In order for the script to work properly
  178. you have to edit the Add and Edit commands in the BBSLIST menu. 
  179. Instead of executing the OA command you need to execute the -E
  180. command, and put the name of the script -- ADDLIST for Add and
  181. EDITLIST for Edit -- in the options field.  You must also supply
  182. the name of the BBS list following the script name.
  183.  
  184.      For example, if you're using the default BBS list --
  185. BBSLIST.BBS -- then your options must read:  ADDLIST BBSLIST (or
  186. EDITLIST BBSLIST) *NEVER* include an extension for the BBS list!!!
  187.  
  188.      Here is the ADDLIST script and an explanation of how it works:
  189.  
  190. -----------------------------------------------------------------
  191. FILEEXIST D:\TG3\DATA\@1@.USE GOTO INUSE
  192. FILECREATE D:\TG3\DATA\@1@.USE
  193. FILEPUT "BBS list being edited in Telegard"
  194. FILECLOSE
  195. MENU OA D:\TG3\DATA\@1@
  196. FILEERASE D:\TG3\DATA\@1@.USE
  197. ENDSCRIPT
  198.  
  199. :INUSE
  200. PUTNL "`0CSorry, you can not add to the BBS list at this time!"
  201. -----------------------------------------------------------------
  202.  
  203.      The FILEEXIST command checks to see if the semaphore file
  204. exists.  The @1@ sequence refers to the first parameter passed to
  205. the script from Telegard -- this is the name of the BBS list you
  206. put in the command options field in the menu editor.  It will be
  207. BBSLIST or MYLIST or whatever the name of the BBS list is.  If
  208. FILEEXIST finds the specified file, it will execute the command
  209. that follows it, which is GOTO INUSE.  The GOTO INUSE command will
  210. jump directly to the :INUSE line and tell the user that he can not
  211. add to the BBS list at this time.
  212.  
  213.      If, however, FILEEXIST does not find the semaphore, it will
  214. first create the semaphore, so that if BBSEdit is executed in
  215. another window it does not open the file, then goes on to execute
  216. the OA menu command to edit the BBS list.  Before ending the script
  217. the sempahore is erased.
  218.  
  219.      The directory used here, D:\TG3\DATA will undoubtedly be
  220. different on your system.  It refers to the DATA directory
  221. specified in your CONFIG.TG.  In reality this can be any directory
  222. where the BBS lists are stored.
  223.  
  224.      The only difference between the ADDLIST script and the EDILIST
  225. script is the MENU command.  For EDLIST it is ON.
  226.  
  227.      On another note, I do not believe this script will work if
  228. youre BBS lists's extension is not .BBS.
  229.  
  230.                           CONTACTING ME
  231.  
  232.      Even if you don't encounter any bugs, please drop me a note. 
  233. If you have any ideas for improvement, thoughts, etc., mail me.  I
  234. can be reached at the following addresses:
  235.  
  236. NetMail:       Sergey Polak @ 1:272/107
  237. Internet:      wp931085@pacevm.dac.pace.edu
  238. BBS:           Hometown's Glass Manazure BBS 914-496-4115
  239.  
  240.      If you post on the TG_SUPPORT echo, I will most likely see the
  241. message and respond.
  242.  
  243.      The latest version of BBSEdit can always be FREQed from
  244. 1:272/107 under the magic name BBSEDIT or downloaded from my
  245. Telegard page on the WWW, which is located at
  246. http://ny.frontiercomm.net/~spolak/telegard.html